Skip to main content
Version: 1.0.2

Get Company

The Get Company API enables to fetch the details of a required company using company ID.

Method: POST​

{{URL}}/jsonrpc

Headers​

NameValue
Content-Typeapplication/json

Example​

Payload Parameters
ParameterDescription

id

Mandatory

String

Unique ID of request

Example – "1"

method

Mandatory

String

Method Name

Example – "VisaService.GetCompany"

params

Object

api

Object

credential

Mandatory

String

API credential provided by NetXD

Example – "Basic cy5wYXJhbWVzd2FyYW4rMkBiYW5rY2J3Lm9yZzpUZXN0QDEyMzQ="

signature

Mandatory

String

Signature of the digitally signed payload

Example – "MEQCICSDF4HIunb4xDLVEK9IOJYhT6j4wq5FwfJILSb4xbeSAiBdmpkV7uPB+39O6S+ea/61ar3dBmBNSU9ay229vin7sA=="

payload

Object

id

Mandatory

String

Unique ID of company

Example – "65e167aba5a5039e373decde"


curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data '{"id":"1","method":"VisaService.GetCompany","params":{"api":{"credential":"Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmNzQ4ZGQ4ZWY4NWI5NWQxY2RlNDE5","signature":"MEQCICSDF4HIunb4xDLVEK9IOJYhT6j4wq5FwfJILSb4xbeSAiBdmpkV7uPB+39O6S+ea/61ar3dBmBNSU9ay229vin7sA=="},"payload":{"id":"65e167aba5a5039e373decde"}}}'

Body​


{
  "id": "1",
  "method": "VisaService.GetCompany",
  "params": {
    "api": {
      "credential": "Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmNzQ4ZGQ4ZWY4NWI5NWQxY2RlNDE5",
      "signature": "MEQCICSDF4HIunb4xDLVEK9IOJYhT6j4wq5FwfJILSb4xbeSAiBdmpkV7uPB+39O6S+ea/61ar3dBmBNSU9ay229vin7sA=="
    },
    "payload": {
      "id": "65e167aba5a5039e373decde"
    }
  }
}

Response: 201​

Response Parameters
ParameterDescription

jsonrpc

String

JSON RPC VERSION

Example – "2.0"

result

Object

company

Object

id

String

Unique ID of company

Example – "65df5bd7bc2422fb17c975f6"

emailId

String

Email address of the company

Example – "cc@gmail.com"

bankId

String

ID of the bank where the company is a customer

Example – "658c2c40a98c5ce653189e57"

createdDate

String

Date and time of the company was created

Example – "2024-02-28T16:14:15.457Z"

active

Boolean

Whether the company is active or not

Example – false

orgName

String

Name of the company

Example – "CCCC"

address1

String

Primary address of the company

Example – "mvn"

countryIsoCode

String

ISO code of the country where the company has its primary location

Example – "243"

approve

Boolean

Whether the company is approved or not

Example – true

accountNumber

String

Account number of company

Example – "12313233 "

defaultCurrencyIsoCode

String

ISO code of the company's default currency

Example – "132 "

businessRegistrationNumber

String

Company's official registration number

Example – "132"

taxId

String

Tax identification number of the company

Example – "123"

corporateLegalName

String

Documented legal name of the company

Example – "gffs"

industryCode

String

Code representing the type of industry the company operates in

Example – "01"

dailyVolume

String

Daily transaction volume limit of company

Example – "99999999990"

singleTransaction

String

Maximum limit allowed for single transaction

Example – "250000"

enterpriseId

String

ID of the company in an enterprise

Example – "V-USA-EUR-10080373-100000001-001"

ceProcessDate

String

Date and time of the riskscore was processed by context engine

Example – "2024-02-28T16:14:20.014Z"

riskScore

String

Level of risk associated with the company

Example – "Disabled"

watchListCount

String

Number of times the company appears on watchlist

Example – "Disabled"

nsProcessDate

String

Date and time of the company was processed for name screening

Example – "0001-01-01T00:00:00Z"

ceReferenceNumber

String

Reference number associated with the process of context engine

Example – "6c7a11789f6541c98fe5d7b038a996ac"

status

String

Current approval status of the company

Example – "WAITING_FOR_APPROVAL"

approvedDate

String

Date and time of the company was approved

Example – "0001-01-01T00:00:00Z"

blockedCurrencyList

Array

ALL

String

Code of the currency restricted from transaction

Example – "ALL"

AMD

String

Code of the currency restricted from transaction

Example – "AMD"

updatedDate

String

Date and time of the company information was last updated

Example – "0001-01-01T00:00:00Z"

owner1WatchListCount

String

Number of times the owner1 of the company appears on watchlist

Example – "Disabled"

owner2WatchListCount

String

Number of times the owner2 of the company appears on watchlist

Example – "Disabled"

owner3WatchListCount

String

Number of times the owner3 of the company appears on watchlist

Example – "Disabled"

companyId

String

Unique identifier of the company

Example – "65df5bd7bc2422fb17c975f6"

isOnFlyCorporate

Boolean

Determines adding new companies for payment

If enabled (True) – allows for addition of new company during payment

If disabled (False) – new company can be added only through ‘addCompany' API call

Example – false

blockedCountries

Array

ALB

String

Code of the blocked country

Example – "ALB"

AGO

String

Code of the blocked country

Example – "AGO"

perTransactionLimit

Number

Maximum number of transactions allowed per time

Example – 3

fxMargin

Number

Margin for foreign exchange transaction

Example – 1

companyTerms

String

Terms and conditions specified by the company

Example – "ytd"

id

String

Unique ID of the request

Example – "1"


{
  "jsonrpc": "2.0",
  "result": {
    "company": {
      "id": "65df5bd7bc2422fb17c975f6",
      "emailId": "cc@gmail.com",
      "bankId": "658c2c40a98c5ce653189e57",
      "createdDate": "2024-02-28T16:14:15.457Z",
      "active": false,
      "orgName": "CCCC",
      "address1": "mvn",
      "countryIsoCode": "243",
      "approve": true,
      "accountNumber": "12313233",
      "defaultCurrencyIsoCode": "132",
      "businessRegistrationNumber": "132",
      "taxId": "123",
      "corporateLegalName": "gffs",
      "industryCode": "01",
      "dailyVolume": "99999999990",
      "singleTransaction": "250000",
      "enterpriseId": "V-USA-EUR-10080373-100000001-001",
      "ceProcessDate": "2024-02-28T16:14:20.014Z",
      "riskScore": "Disabled",
      "watchListCount": "Disabled",
      "nsProcessDate": "0001-01-01T00:00:00Z",
      "ceReferenceNumber": "6c7a11789f6541c98fe5d7b038a996ac",
      "status": "WAITING_FOR_APPROVAL",
      "approvedDate": "0001-01-01T00:00:00Z",
      "blockedCurrencyList": [
        "ALL",
        "AMD"
      ],
      "updatedDate": "0001-01-01T00:00:00Z",
      "owner1WatchListCount": "Disabled",
      "owner2WatchListCount": "Disabled",
      "owner3WatchListCount": "Disabled",
      "companyId": "65df5bd7bc2422fb17c975f6",
      "isOnFlyCorporate": false,
      "blockedCountries": [
        "ALB",
        "AGO"
      ],
      "perTransactionLimit": 3,
      "fxMargin": 1,
      "companyTerms": "ytd"
    }
  },
  "id": "1"
}